Vapi Metadata Metamodel ComponentInfo

Vapi Metadata Metamodel ComponentInfo
Vapi Metadata Metamodel ComponentInfo

The Vapi Metadata Metamodel ComponentInfo schema contains metamodel metadata information about a component element.

JSON Example
{
    "name": "string",
    "packages": {
        "packages": {
            "name": "string",
            "structures": {
                "structures": {
                    "name": "string",
                    "type": "string",
                    "enumerations": {
                        "enumerations": {
                            "name": "string",
                            "values": [
                                {
                                    "value": "string",
                                    "metadata": {
                                        "metadata": {
                                            "elements": {
                                                "elements": {
                                                    "type": "string",
                                                    "long_value": 0,
                                                    "string_value": "string",
                                                    "list_value": [
                                                        "string"
                                                    ],
                                                    "structure_id": "string",
                                                    "structure_ids": [
                                                        "string"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "documentation": "string"
                                }
                            ],
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    },
                    "constants": {
                        "constants": {
                            "type": {
                                "category": "string",
                                "builtin_type": "string",
                                "user_defined_type": {
                                    "resource_type": "string",
                                    "resource_id": "string"
                                },
                                "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                            },
                            "value": {
                                "category": "string",
                                "primitive_value": {
                                    "type": "string",
                                    "boolean_value": false,
                                    "double_value": "number",
                                    "long_value": 0,
                                    "string_value": "string"
                                },
                                "list_value": [
                                    {
                                        "type": "string",
                                        "boolean_value": false,
                                        "double_value": "number",
                                        "long_value": 0,
                                        "string_value": "string"
                                    }
                                ]
                            },
                            "documentation": "string"
                        }
                    },
                    "fields": [
                        {
                            "name": "string",
                            "type": {
                                "category": "string",
                                "builtin_type": "string",
                                "user_defined_type": {
                                    "resource_type": "string",
                                    "resource_id": "string"
                                },
                                "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                            },
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    ],
                    "metadata": {
                        "metadata": {
                            "elements": {
                                "elements": {
                                    "type": "string",
                                    "long_value": 0,
                                    "string_value": "string",
                                    "list_value": [
                                        "string"
                                    ],
                                    "structure_id": "string",
                                    "structure_ids": [
                                        "string"
                                    ]
                                }
                            }
                        }
                    },
                    "documentation": "string"
                }
            },
            "enumerations": {
                "enumerations": {
                    "name": "string",
                    "values": [
                        {
                            "value": "string",
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    ],
                    "metadata": {
                        "metadata": {
                            "elements": {
                                "elements": {
                                    "type": "string",
                                    "long_value": 0,
                                    "string_value": "string",
                                    "list_value": [
                                        "string"
                                    ],
                                    "structure_id": "string",
                                    "structure_ids": [
                                        "string"
                                    ]
                                }
                            }
                        }
                    },
                    "documentation": "string"
                }
            },
            "services": {
                "services": {
                    "name": "string",
                    "operations": {
                        "operations": {
                            "name": "string",
                            "params": [
                                {
                                    "name": "string",
                                    "type": {
                                        "category": "string",
                                        "builtin_type": "string",
                                        "user_defined_type": {
                                            "resource_type": "string",
                                            "resource_id": "string"
                                        },
                                        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                                    },
                                    "metadata": {
                                        "metadata": {
                                            "elements": {
                                                "elements": {
                                                    "type": "string",
                                                    "long_value": 0,
                                                    "string_value": "string",
                                                    "list_value": [
                                                        "string"
                                                    ],
                                                    "structure_id": "string",
                                                    "structure_ids": [
                                                        "string"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "documentation": "string"
                                }
                            ],
                            "output": {
                                "type": {
                                    "category": "string",
                                    "builtin_type": "string",
                                    "user_defined_type": {
                                        "resource_type": "string",
                                        "resource_id": "string"
                                    },
                                    "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                                },
                                "metadata": {
                                    "metadata": {
                                        "elements": {
                                            "elements": {
                                                "type": "string",
                                                "long_value": 0,
                                                "string_value": "string",
                                                "list_value": [
                                                    "string"
                                                ],
                                                "structure_id": "string",
                                                "structure_ids": [
                                                    "string"
                                                ]
                                            }
                                        }
                                    }
                                },
                                "documentation": "string"
                            },
                            "errors": [
                                {
                                    "structure_id": "string",
                                    "documentation": "string"
                                }
                            ],
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    },
                    "structures": {
                        "structures": {
                            "name": "string",
                            "type": "string",
                            "enumerations": {
                                "enumerations": {
                                    "name": "string",
                                    "values": [
                                        {
                                            "value": "string",
                                            "metadata": {
                                                "metadata": {
                                                    "elements": {
                                                        "elements": {
                                                            "type": "string",
                                                            "long_value": 0,
                                                            "string_value": "string",
                                                            "list_value": [
                                                                "string"
                                                            ],
                                                            "structure_id": "string",
                                                            "structure_ids": [
                                                                "string"
                                                            ]
                                                        }
                                                    }
                                                }
                                            },
                                            "documentation": "string"
                                        }
                                    ],
                                    "metadata": {
                                        "metadata": {
                                            "elements": {
                                                "elements": {
                                                    "type": "string",
                                                    "long_value": 0,
                                                    "string_value": "string",
                                                    "list_value": [
                                                        "string"
                                                    ],
                                                    "structure_id": "string",
                                                    "structure_ids": [
                                                        "string"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "documentation": "string"
                                }
                            },
                            "constants": {
                                "constants": {
                                    "type": {
                                        "category": "string",
                                        "builtin_type": "string",
                                        "user_defined_type": {
                                            "resource_type": "string",
                                            "resource_id": "string"
                                        },
                                        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                                    },
                                    "value": {
                                        "category": "string",
                                        "primitive_value": {
                                            "type": "string",
                                            "boolean_value": false,
                                            "double_value": "number",
                                            "long_value": 0,
                                            "string_value": "string"
                                        },
                                        "list_value": [
                                            {
                                                "type": "string",
                                                "boolean_value": false,
                                                "double_value": "number",
                                                "long_value": 0,
                                                "string_value": "string"
                                            }
                                        ]
                                    },
                                    "documentation": "string"
                                }
                            },
                            "fields": [
                                {
                                    "name": "string",
                                    "type": {
                                        "category": "string",
                                        "builtin_type": "string",
                                        "user_defined_type": {
                                            "resource_type": "string",
                                            "resource_id": "string"
                                        },
                                        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                                    },
                                    "metadata": {
                                        "metadata": {
                                            "elements": {
                                                "elements": {
                                                    "type": "string",
                                                    "long_value": 0,
                                                    "string_value": "string",
                                                    "list_value": [
                                                        "string"
                                                    ],
                                                    "structure_id": "string",
                                                    "structure_ids": [
                                                        "string"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "documentation": "string"
                                }
                            ],
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    },
                    "enumerations": {
                        "enumerations": {
                            "name": "string",
                            "values": [
                                {
                                    "value": "string",
                                    "metadata": {
                                        "metadata": {
                                            "elements": {
                                                "elements": {
                                                    "type": "string",
                                                    "long_value": 0,
                                                    "string_value": "string",
                                                    "list_value": [
                                                        "string"
                                                    ],
                                                    "structure_id": "string",
                                                    "structure_ids": [
                                                        "string"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    "documentation": "string"
                                }
                            ],
                            "metadata": {
                                "metadata": {
                                    "elements": {
                                        "elements": {
                                            "type": "string",
                                            "long_value": 0,
                                            "string_value": "string",
                                            "list_value": [
                                                "string"
                                            ],
                                            "structure_id": "string",
                                            "structure_ids": [
                                                "string"
                                            ]
                                        }
                                    }
                                }
                            },
                            "documentation": "string"
                        }
                    },
                    "constants": {
                        "constants": {
                            "type": {
                                "category": "string",
                                "builtin_type": "string",
                                "user_defined_type": {
                                    "resource_type": "string",
                                    "resource_id": "string"
                                },
                                "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
                            },
                            "value": {
                                "category": "string",
                                "primitive_value": {
                                    "type": "string",
                                    "boolean_value": false,
                                    "double_value": "number",
                                    "long_value": 0,
                                    "string_value": "string"
                                },
                                "list_value": [
                                    {
                                        "type": "string",
                                        "boolean_value": false,
                                        "double_value": "number",
                                        "long_value": 0,
                                        "string_value": "string"
                                    }
                                ]
                            },
                            "documentation": "string"
                        }
                    },
                    "metadata": {
                        "metadata": {
                            "elements": {
                                "elements": {
                                    "type": "string",
                                    "long_value": 0,
                                    "string_value": "string",
                                    "list_value": [
                                        "string"
                                    ],
                                    "structure_id": "string",
                                    "structure_ids": [
                                        "string"
                                    ]
                                }
                            }
                        }
                    },
                    "documentation": "string"
                }
            },
            "metadata": {
                "metadata": {
                    "elements": {
                        "elements": {
                            "type": "string",
                            "long_value": 0,
                            "string_value": "string",
                            "list_value": [
                                "string"
                            ],
                            "structure_id": "string",
                            "structure_ids": [
                                "string"
                            ]
                        }
                    }
                }
            },
            "documentation": "string"
        }
    },
    "metadata": {
        "metadata": {
            "elements": {
                "elements": {
                    "type": "string",
                    "long_value": 0,
                    "string_value": "string",
                    "list_value": [
                        "string"
                    ],
                    "structure_id": "string",
                    "structure_ids": [
                        "string"
                    ]
                }
            }
        }
    },
    "documentation": "string"
}
string
name
Required

Dot separated name of the component element. The segments in the name reflect the organization of the APIs. The format of each segment is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

object
packages
Required

Metamodel metadata information of all the package elements contained in the component element. The key in the map is the identifier of the package element and the value in the map is the metamodel information of the package element.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vapi.package. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vapi.package.

object
metadata
Required

Generic metadata for the component element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.

string
documentation
Required

English language documentation for a component. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first sentence of the package documentation is a complete sentence that identifies the component by name and summarizes the purpose of the component.